<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>XMP Toolkit SDK: AdobeXMPCommon::IThreadSafe Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xmp_tagline_small.jpg"/></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">XMP Toolkit SDK
   &#160;<span id="projectnumber">6.0.0</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',false,false,'search.php','Search');
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('classAdobeXMPCommon_1_1IThreadSafe.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> &#124;
<a href="classAdobeXMPCommon_1_1IThreadSafe-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">AdobeXMPCommon::IThreadSafe Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div>  </div>
</div><!--header-->
<div class="contents">

<p>Interface that serves as the base interface for all the externally exposed interfaces which needs to provide client configurable thread safety.  
 <a href="classAdobeXMPCommon_1_1IThreadSafe.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="IThreadSafe_8h_source.html">IThreadSafe.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for AdobeXMPCommon::IThreadSafe:</div>
<div class="dyncontent">
 <div class="center">
  <img src="classAdobeXMPCommon_1_1IThreadSafe.png" usemap="#AdobeXMPCommon::IThreadSafe_map" alt=""/>
  <map id="AdobeXMPCommon::IThreadSafe_map" name="AdobeXMPCommon::IThreadSafe_map">
<area href="classAdobeXMPCore_1_1INameSpacePrefixMap__v1.html" title="Version1 of the interface that represents map where each entry consists of prefix string as the key a..." alt="AdobeXMPCore::INameSpacePrefixMap_v1" shape="rect" coords="0,56,261,80"/>
<area href="classAdobeXMPCore_1_1INode__v1.html" title="Version1 of the interface that serves as a base interface to all types of nodes in the XMP DOM." alt="AdobeXMPCore::INode_v1" shape="rect" coords="271,56,532,80"/>
<area href="classAdobeXMPCore_1_1ICompositeNode__v1.html" title="Version1 of the interface that serves as a base interface to all composite types of nodes in the XMP ..." alt="AdobeXMPCore::ICompositeNode_v1" shape="rect" coords="135,112,396,136"/>
<area href="classAdobeXMPCore_1_1ISimpleNode__v1.html" title="Version1 of the interface that represents a Simple Property Node of XMP DOM." alt="AdobeXMPCore::ISimpleNode_v1" shape="rect" coords="406,112,667,136"/>
<area href="classAdobeXMPCore_1_1IArrayNode__v1.html" title="Version1 of the interface that represents an Array Node of XMP DOM." alt="AdobeXMPCore::IArrayNode_v1" shape="rect" coords="0,168,261,192"/>
<area href="classAdobeXMPCore_1_1IStructureNode__v1.html" title="Version1 of the interface that represents a structure Node of XMP DOM." alt="AdobeXMPCore::IStructureNode_v1" shape="rect" coords="271,168,532,192"/>
<area href="classAdobeXMPCore_1_1IMetadata__v1.html" title="Version1 of the interface that represents the whole xmp metadata for an asset." alt="AdobeXMPCore::IMetadata_v1" shape="rect" coords="271,224,532,248"/>
  </map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:afe35614cb88e2bdb32996cf4ac15b211"><td class="memItemLeft" align="right" valign="top">virtual void APICALL&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAdobeXMPCommon_1_1IThreadSafe.html#afe35614cb88e2bdb32996cf4ac15b211">EnableThreadSafety</a> () const <a class="el" href="XMPCommonDefines_8h.html#a5a929113d3d50bda3fb7135a5c8b24a2">__NOTHROW__</a>=0</td></tr>
<tr class="memdesc:afe35614cb88e2bdb32996cf4ac15b211"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enables the thread safety on an object.  <a href="classAdobeXMPCommon_1_1IThreadSafe.html#afe35614cb88e2bdb32996cf4ac15b211">More...</a><br /></td></tr>
<tr class="separator:afe35614cb88e2bdb32996cf4ac15b211"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a214bb1b5840dbd5576e764dd2220b261"><td class="memItemLeft" align="right" valign="top">virtual void APICALL&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAdobeXMPCommon_1_1IThreadSafe.html#a214bb1b5840dbd5576e764dd2220b261">DisableThreadSafety</a> () const <a class="el" href="XMPCommonDefines_8h.html#a5a929113d3d50bda3fb7135a5c8b24a2">__NOTHROW__</a>=0</td></tr>
<tr class="memdesc:a214bb1b5840dbd5576e764dd2220b261"><td class="mdescLeft">&#160;</td><td class="mdescRight">Disables the thread safety on an object.  <a href="classAdobeXMPCommon_1_1IThreadSafe.html#a214bb1b5840dbd5576e764dd2220b261">More...</a><br /></td></tr>
<tr class="separator:a214bb1b5840dbd5576e764dd2220b261"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a30d666826eba6dfed60c0760e145bee3"><td class="memItemLeft" align="right" valign="top">virtual bool APICALL&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAdobeXMPCommon_1_1IThreadSafe.html#a30d666826eba6dfed60c0760e145bee3">IsThreadSafe</a> () const =0</td></tr>
<tr class="memdesc:a30d666826eba6dfed60c0760e145bee3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Informs whether object can be used across multiple threads or not.  <a href="classAdobeXMPCommon_1_1IThreadSafe.html#a30d666826eba6dfed60c0760e145bee3">More...</a><br /></td></tr>
<tr class="separator:a30d666826eba6dfed60c0760e145bee3"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:a0f31eb9677c4af06288319e363c21ebc"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAdobeXMPCommon_1_1IThreadSafe.html#a0f31eb9677c4af06288319e363c21ebc">REQ_FRIEND_CLASS_DECLARATION</a> ()</td></tr>
<tr class="separator:a0f31eb9677c4af06288319e363c21ebc"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Interface that serves as the base interface for all the externally exposed interfaces which needs to provide client configurable thread safety. </p>
<dl class="section attention"><dt>Attention</dt><dd>In case client has disabled thread safety at the module level these functions will have no use. </dd></dl>
<dl class="section note"><dt>Note</dt><dd>By default all the objects created are not thread safe. </dd></dl>

<p class="definition">Definition at line <a class="el" href="IThreadSafe_8h_source.html#l00029">29</a> of file <a class="el" href="IThreadSafe_8h_source.html">IThreadSafe.h</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a214bb1b5840dbd5576e764dd2220b261"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a214bb1b5840dbd5576e764dd2220b261">&#9670;&nbsp;</a></span>DisableThreadSafety()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual void APICALL AdobeXMPCommon::IThreadSafe::DisableThreadSafety </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Disables the thread safety on an object. </p>
<p>After calling this function the object should not be used across multiple threads. </p>

</div>
</div>
<a id="afe35614cb88e2bdb32996cf4ac15b211"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afe35614cb88e2bdb32996cf4ac15b211">&#9670;&nbsp;</a></span>EnableThreadSafety()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual void APICALL AdobeXMPCommon::IThreadSafe::EnableThreadSafety </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Enables the thread safety on an object. </p>
<p>After calling this function the object can be used across multiple threads. </p>

</div>
</div>
<a id="a30d666826eba6dfed60c0760e145bee3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a30d666826eba6dfed60c0760e145bee3">&#9670;&nbsp;</a></span>IsThreadSafe()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual bool APICALL AdobeXMPCommon::IThreadSafe::IsThreadSafe </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Informs whether object can be used across multiple threads or not. </p>
<dl class="section return"><dt>Returns</dt><dd>bool value; true in case object can be used across multiple threads, false otherwise. </dd></dl>

</div>
</div>
<a id="a0f31eb9677c4af06288319e363c21ebc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0f31eb9677c4af06288319e363c21ebc">&#9670;&nbsp;</a></span>REQ_FRIEND_CLASS_DECLARATION()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">AdobeXMPCommon::IThreadSafe::REQ_FRIEND_CLASS_DECLARATION </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>public/include/XMPCommon/Interfaces/BaseInterfaces/<a class="el" href="IThreadSafe_8h_source.html">IThreadSafe.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="namespaceAdobeXMPCommon.html">AdobeXMPCommon</a></li><li class="navelem"><a class="el" href="classAdobeXMPCommon_1_1IThreadSafe.html">IThreadSafe</a></li>
    <li class="footer">Generated by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.17 </li>
  </ul>
</div>
</body>
</html>
